MetadataNodeReader.GetDescriptions Method (CultureInfo)

Gets a collection of general description values that most closely match the requested culture.

Parent Type: MetadataNodeReader

Namespace: Microsoft.LearningComponents.Manifest

Assembly: Microsoft.LearningComponents.dll

Syntax
C#

public ReadOnlyCollection<string> GetDescriptions (
CultureInfo culture

)

Parameters

culture

The culture used to determine which descriptions to return.

Return Value

The description that best matches the specified culture, or an empty collection if no descriptions exist.

Exceptions
Exception type Condition
InvalidPackageException

This is the first call to this method, and the metadata is located in a metadata file that can not be found.

Remarks

This <description> blocks in the metadata should each contain consistent language strings, or unpredictable values may be returned from this method.

Note that an InvalidPackageException may be thrown on the first call to this method. If this happens, subsequent calls do not throw additional exceptions. Instead, String.Empty is returned.

If Location is an absolute URI, this method returns String.Empty because absolute URI is not supported.